Correct the type of $tidy->errorBuffer #3528
Conversation
| @@ -9,7 +9,7 @@ | |||
| <refsect1 role="description"> | |||
| &reftitle.description; | |||
| <para>&style.oop; (property):</para> | |||
| <fieldsynopsis><modifier>public</modifier> <type>string</type><varname linkend="tidy.props.errorbuffer">tidy->errorBuffer</varname></fieldsynopsis> | |||
| <fieldsynopsis><modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><varname linkend="tidy.props.errorbuffer">tidy->errorBuffer</varname></fieldsynopsis> | |||
| <para>&style.procedural;:</para> | |||
There was a problem hiding this comment.
RIght. It looks like the tidy properties are not documented according to the stubs (tidy::$value isn't documented at all). /cc @kocsismate
There was a problem hiding this comment.
They actually are documented on the class overview page: https://www.php.net/manual/en/class.tidy
This page is about the error buffer itself.
There was a problem hiding this comment.
Oh, indeed! I was looking at https://www.php.net/manual/en/book.tidy.php, where ::$value is missing. And also all properties of tidyNode. Might be a PhD issue; I'll see to it.
There was a problem hiding this comment.
Actually, there is no issue; it's just that ::$errorBuffer is documented on its own page, while ::$value is documented on the class page. Sorry for the noise.
This is a nullable string: https://github.com/php/php-src/blob/e9254494ffde88af0160a30cee53c3dfce226edf/ext/tidy/tidy.stub.php#L866